home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / archive / dirarc10.arj / DIRARC10.EXE / DIRARC.DOC < prev    next >
Text File  |  1994-02-16  |  12KB  |  254 lines
  1.  
  2.  
  3. DIRARC v1.00 Shareware release documentation.                     February 1994
  4.  
  5.  
  6. ==============================INTRODUCTION=====================================
  7.  
  8.  
  9.   I wrote DIRARC out of necessity. I have alot of directories which contain
  10.   files that I seldom use, but I need to keep these directories on my hard
  11.   disk nonetheless. So even though I seldom use them, I still need them to
  12.   be present when I do require them. Thus it occurred to me that it would be
  13.   nice if I could archive these directories and save some space on my hard
  14.   disk. (We all know how valuable hard disk space is in these days of space
  15.   eating applications!)
  16.  
  17.   Anyhow, after writing some fairly intensive batch files to handle this
  18.   process, I decided it would be easier to create a program to take care of
  19.   this chore, and with that DIRARC v1.00 was created.
  20.  
  21.   DIRARC will do the following:
  22.  
  23.   (1) It will use either PKZIP/PKUNZIP, LHA, or the ARJ compression
  24.       utilities to archive your directory(s) into one file.
  25.  
  26.   (2) It is capable of creating archives that are executable and/or which
  27.       contain sub-directories.
  28.  
  29.   (3) After DIRARC creates the archive, it allows you the option to delete
  30.       the files it has archived. Thus you would be left with only one file,
  31.       the archive, which is named after the first eight letters of the
  32.       directory name, or "ROOT" in the case of the DOS root directory.
  33.  
  34.   (4) Whenever you need the directory to be decompressed, you can either
  35.       run DIRARC with the decompress option, or "manually" decompress them
  36.       with the desired archiving program should you choose.
  37.  
  38.  
  39. ==============================INSTALLATION=====================================
  40.  
  41.  
  42.   DIRARC is as easy to install as it is to use. Just run the INSTALL.EXE
  43.   program and it will copy the file DIRARC.EXE to the install directory,
  44.   either \DIRARC of the current drive, or the drive and directory that you
  45.   select when prompted by the INSTALL program. DIRARC.EXE is actually a
  46.   self-extracting archive that will explode the installation files after
  47.   being copied to the desired drive. After installation be sure to read ALL
  48.   of the accompanying documentation.
  49.  
  50.   Once you have installed DIRARC, you should add the DIRARC directory to
  51.   your DOS PATH statement in your AUTOEXEC.BAT file, or SET the PATH
  52.   statement to point to this directory manually. To add DIRARC to your
  53.   DOS PATH via your AUTOEXEC.BAT file, then load AUTOEXEC.BAT in your
  54.   editor and edit as so:
  55.  
  56.   PATH=C:\DOS;                      <- Example PATH statement in AUTOEXEC.BAT
  57.   PATH=C:\DOS;C:\DIRARC;            <- DIRARC added to PATH statement
  58.  
  59.   Furthermore, DIRARC will not operate unless it can locate PKZIP/PKUNZIP,
  60.   LHA, or ARJ in your DOS PATH. So your PATH should also point to the
  61.   directory containing one, or more of these utilities.
  62.  
  63.   NOTE: During installation you may choose the drive and directory which to
  64.   install to, it is suggested that you install DIRARC to the same directory
  65.   where one or all of these archivers are kept. ex: \UTILITY, and then make
  66.   sure that that directory is in your DOS PATH statement.
  67.  
  68.   Lastly, if you are unsure of how to change your DOS PATH statement, then
  69.   refer to your DOS documentation for further information regarding this
  70.   topic.
  71.  
  72.  
  73. ===========================DIRARC COMMAND USAGE================================
  74.  
  75.  
  76.   The DIRARC command line is outlined as so:
  77.  
  78.   Usage    : DIRARC [/C,/D] [Archive Type] [/S] [/E] [/Q] [/P#]
  79.                                                                                 
  80.              /C = CREATE Archive          /Z = PKZip
  81.              /D = DECOMPRESS Archive      /A = ARJ
  82.                                           /L = LHArc
  83.                                                                                 
  84.              /S  = Include Sub-Directories
  85.              /E  = Create Self-Extracting Archive
  86.              /Q  = Quiet Mode (Don't Display Progress)
  87.              /P0 = No Prompt (Delete Files)
  88.              /P1 = No Prompt (Don't Delete Files)
  89.                                                                                 
  90.   Example  : DIRARC /C /Z /S /E /Q /P0
  91.  
  92.   Result   : Creates .ZIPed executable archive w/ sub-directories included,
  93.              and deletes files after added to archive without prompting.
  94.                                                                                 
  95.  
  96.   DIRARC handles its command line pretty dynamically, meaning that you
  97.   could enter something like:
  98.  
  99.              DIRARC /C /Z /E /P0 /Q /S
  100.  
  101.   and achieve the same results as the example above. The first two
  102.   arguments, however, are important and required at the minimum, in the
  103.   order shown. i.e:
  104.  
  105.              DIRARC /C /Z - Create archive using PKZIP
  106.              DIRARC /C /L - Create archive using LHA
  107.              DIRARC /C /A - Create archive using ARJ
  108.              DIRARC /D /Z - Decompress archive using PKUNZIP
  109.              DIRARC /D /L - Decompress archive using LHA
  110.              DIRARC /D /A - Decompress archive using ARJ
  111.  
  112.   NOTE: the first argument *must* be either /C or /D to either CREATE and
  113.         compress or to DECOMPRESS an archive. Furthermore, the second
  114.         argument *must* be the archiver type. (/Z for PKZIP/PKUNZIP, /L
  115.         for LHA, or /A for ARJ).
  116.  
  117.   Additionally, you must have PKZIP/PKUNZIP, LHA, or ARJ in your DOS PATH
  118.   statement to use DIRARC. DIRARC will automatically check for the presence
  119.   of one of these archivers in your path and if it can't locate them then
  120.   it will end its run.
  121.  
  122.   The other command line arguments may be mixed and matched, that is they
  123.   can be entered in any order you wish. They are defined as such:
  124.  
  125.   /S  = Include Sub-Directories - This option will archive all of the files
  126.         in the current directory, name that archive after the current
  127.         directory, and also include the sub-directories and files within
  128.         those as well, in the archive.
  129.  
  130.   /E  = Create Self-Extracting Archive - This option creates a self-extracting
  131.         archive which allows you to run the archive and it will extract the
  132.         files without the need of DIRARC *or* the archiving utility that you
  133.         used to create the archive. NOTE: It is suggested that you use DIRARC
  134.         or the original archiver if you intend to decompress a self-extracting
  135.         archive that contains sub-directories. For instance, an archive created
  136.         with PKZIP and ZIP2EXE which has sub-directories will not restore the
  137.         sub-directories unless you use the command line switch "-d" when
  138.         running the file.
  139.  
  140.   /Q  = Quiet Mode (Don't Display Progress) - This option allows you to toggle
  141.         the output off. So when DIRARC is run and it calls the archiver to
  142.         compress the files and create the archive, you do not see the progress
  143.         displayed on the screen. This is useful for when you wish to run
  144.         DIRARC from a batch file and don't need to see the messages displayed
  145.         by DIRARC or the archive utility that has been selected.
  146.  
  147.   /P0 = No Prompt (Delete Files) - Toggling this option on will cause DIRARC
  148.         to automatically delete the files that have been archived and not
  149.         prompt you to verify that this is done.
  150.  
  151.   /P1 = No Prompt (Don't Delete Files) - Toggling this option will cause
  152.         DIRARC to ignore the files that it has archived and not prompt you
  153.         to delete them.
  154.  
  155.   NOTE: If you do not use the command line arguments /P0 or /P1 then DIRARC
  156.         will prompt you as to whether you want to delete the files that have
  157.         been archived. The /P arguments are good for use in batch files that
  158.         are run when you are not present at the computer to answer this
  159.         prompting.
  160.  
  161.  
  162.   A note on decompressing an archive:
  163.  
  164.   After DIRARC has decompressed an archive which it earlier helped to
  165.   create, it will erase the original archive file. Thus the program does a
  166.   good job of "cleaning up after itself."
  167.  
  168.  
  169. ==============================BATCH FILE USAGE=================================
  170.  
  171.  
  172.   The DIRARC installation package includes a set of BATCH files to make the
  173.   usage of this program even easier. Instead of remembering command line
  174.   arguments you can just run the required batch file and it will take care
  175.   of the process for you. Note: None of these batch files suspend the file
  176.   deletion prompting, so DIRARC will ask you whether you want to delete the
  177.   files that have been archived when these batch files are used. If you want
  178.   to suppress this prompting via the /P0 or /P1 switches, then you will need
  179.   to edit these batch files accordingly. Below is a brief summary of each of
  180.   these batch files:
  181.  
  182.   [BATCH FILES FOR CREATING ARCHIVES]
  183.  
  184.   PKZS     BAT: Create a PKZIP archive which includes sub-directories.
  185.   LHAS     BAT: Create a LHA archive which includes sub-directories.
  186.   ARJS     BAT: Create a ARJ archive which includes sub-directories.
  187.  
  188.   PKZSE    BAT: Create a self-extracting PKZIP archive which contains
  189.                 sub-directories.
  190.   LHASE    BAT: Create a self-extracting LHA archive which contains
  191.                 sub-directories.
  192.   ARJSE    BAT: Create a self-extracting ARJ archive which contains
  193.                 sub-directories.
  194.  
  195.   PKZSEQ   BAT: Create a self-extracting PKZIP archive which includes
  196.                 sub-directories and do not report progress to screen.
  197.   LHASEQ   BAT: Create a self-extracting LHA archive which includes
  198.                 sub-directories and do not report progress to screen.
  199.   ARJSEQ   BAT: Create a self-extracting ARJ archive which includes
  200.                 sub-directories and do not report progress to screen.
  201.  
  202.   [BATCH FILES FOR DECOMPRESSING ARCHIVES]
  203.  
  204.   UNPKZS   BAT: Decompress a PKZIP archive which contains sub-directories.
  205.   UNLHAS   BAT: Decompress a LHA archive which contains sub-directories.
  206.   UNARJS   BAT: Decompress a ARJ archive which contains sub-directories.
  207.  
  208.   UNPKZSE  BAT: Decompress a self-extracting PKZIP archive which contains
  209.                 sub-directories.
  210.   UNLHASE  BAT: Decompress a self-extracting LHA archive which contains
  211.                 sub-directories.
  212.   UNARJSE  BAT: Decompress a self-extracting ARJ archive which contains
  213.                 sub-directories.
  214.  
  215.   UNPKZSEQ BAT: Decompress a self-extracting PKZIP archive which contains
  216.                 sub-directories and do not report progress to screen.
  217.   UNLHASEQ BAT: Decompress a self-extracting LHA archive which contains
  218.                 sub-directories and do not report progress to screen.
  219.   UNARJSEQ BAT: Decompress a self-extracting ARJ archive which contains
  220.                 sub-directories and do not report progress to screen.
  221.  
  222. ===============================================================================
  223.  
  224.   Please feel free to send comments, suggestions, ideas, criticisms, or what
  225.   have you to the address listed in REGISTER.DOC. Continued support and
  226.   upgrading of this program depends upon feedback from its users so your
  227.   input is of great value to us at HandMade Software.
  228.  
  229.   Thank-you for evaluating this product.
  230.  
  231.   See also: README.DOC
  232.             THANKS.DOC
  233.             REGISTER.DOC
  234.             LICENSE.DOC
  235.  
  236.  
  237. ============================[COPYRIGHT NOTICES]================================
  238.  
  239.   PKZIP and PKUNZIP are registered trademarks of PKWARE, Inc.
  240.  
  241.   LHA copyrighted (c) by HARUYASU YOSHIZAKI
  242.  
  243.   ARJ copyrighted (c) 1990-93 by Robert K Jung.
  244.  
  245.   Trademarks of other companies mentioned appear for identification
  246.   purposes only and are the property of their respective companies or
  247.   authors.
  248.  
  249. ===============================================================================
  250.  
  251.  
  252. EOT
  253.  
  254.